HP Operations Manager for Windows

com.hp.openview.ib.api.jopc
Class JOpcMessage


java.lang.Object
  |
  +--com.hp.openview.ib.api.jopc.JOpcObject
		|
		+--com.hp.openview.ib.api.jopc.JOpcMessage
All Implemented Interfaces:
java.lang.Cloneable, JOpcApiDefinition
Direct Known Subclasses:
JOpcAgentMessage
public abstract class JOpcMessage
extends JOpcObject

Provides a object oriented java class with getter() and setter(), corresponding to the HPOM Data Structure "OPCDTYPE_MESSAGE". This data structure is needed in context of HPOM APIs "Agent Message API" .

Constructor Summary
JOpcMessage()
          constructs a new JOpcMessage
 
Method Summary
 java.lang.String getApplication()
          Will load application which produced the message.
 long getDataInfo()
          Will load additional information about the message.
 long getDataType()
          Will load the type of the opcdata object.
 java.lang.String getGroup()
          Will load message group.
 java.lang.String getMsgid()
          Will load The unique ID of the message.
 java.lang.String getMsgtext()
          Will load message text.
 java.lang.String getNodename()
          Will load Name of the node producing the message.
 java.lang.String getObject()
          Will load Object name to use for the HPOM message.
 java.lang.String getServiceName()
          Will load the service name.
 long getSeverity()
          Will load severity of the message.
 void setApplication(java.lang.String aValue)
          Sets application which produced the message.
 void setDataInfo(long aValue)
          Sets additional information about the message.
 void setGroup(java.lang.String aValue)
          Sets message group.
 void setMsgid(java.lang.String aValue)
          Set the unique ID of the message.
 void setMsgtext(java.lang.String aValue)
          Sets message text.
 void setNodename(java.lang.String aValue)
          Sets Name of the node producing the message.
 void setObject(java.lang.String aValue)
          Sets Object name to use for the HPOM message.
 void setOptionVar(java.lang.String aValue)
          Sets A string containing the optional parameters used for resolving the $OPTION variables by the message interceptor.
 void setServiceName(java.lang.String aValue)
          Sets the service name.
 void setSeverity(long aValue)
          Sets severity of the message.

Constructor Detail

JOpcMessage

public JOpcMessage()
			throws JOpcException
constructs a new JOpcMessage
Method Detail

getDataType

public long getDataType()
				 throws JOpcException
Will load the type of the opcdata object.

getSeverity

public long getSeverity()
				 throws JOpcException
Will load severity of the message. 
 Possible values are:
 OPC_SEV_UNCHANGED
 OPC_SEV_UNKNOWN
 OPC_SEV_NORMAL
 OPC_SEV_WARNING
 OPC_SEV_CRITICAL
 OPC_SEV_MINOR
 OPC_SEV_MAJOR

setSeverity

public void setSeverity(long aValue)
				 throws JOpcException
Sets severity of the message. 
 Possible values are:
 OPC_SEV_UNCHANGED
 OPC_SEV_UNKNOWN
 OPC_SEV_NORMAL
 OPC_SEV_WARNING
 OPC_SEV_CRITICAL
 OPC_SEV_MINOR
 OPC_SEV_MAJOR

getDataInfo

public long getDataInfo()
				 throws JOpcException
Will load additional information about the message. 
 OPC_REMARK_FOR_ACK

setDataInfo

public void setDataInfo(long aValue)
				 throws JOpcException
Sets additional information about the message. 
 OPC_REMARK_FOR_ACK

getApplication

public java.lang.String getApplication()
								throws JOpcException
Will load application which produced the message. Default: empty string

setApplication

public void setApplication(java.lang.String aValue)
					throws JOpcException
Sets application which produced the message. Default: empty string

getGroup

public java.lang.String getGroup()
						throws JOpcException
Will load message group. Default: empty string.

setGroup

public void setGroup(java.lang.String aValue)
			throws JOpcException
Sets message group. Default: empty string.

getMsgtext

public java.lang.String getMsgtext()
							throws JOpcException
Will load message text. Default: empty string.

setMsgtext

public void setMsgtext(java.lang.String aValue)
				throws JOpcException
Sets message text. Default: empty string.

getNodename

public java.lang.String getNodename()
							 throws JOpcException
Will load Name of the node producing the message. The message is only handled by the HPOM manager if this system is part of the HPOM Node Bank.
Default: local node name.

setNodename

public void setNodename(java.lang.String aValue)
				 throws JOpcException
Sets Name of the node producing the message. The message is only handled by the HPOM manager if this system is part of the HPOM Node Bank.
Default: local node name.

getObject

public java.lang.String getObject()
						 throws JOpcException
Will load Object name to use for the HPOM message. Default: empty string.

setObject

public void setObject(java.lang.String aValue)
			 throws JOpcException
Sets Object name to use for the HPOM message. Default: empty string.

getMsgid

public java.lang.String getMsgid()
						throws JOpcException
Will load The unique ID of the message.

setMsgid

public void setMsgid(java.lang.String aValue)
			throws JOpcException
Set the unique ID of the message. Applies to operations dealing with just a reference to a message (for example, acknowledge(), own(), and so on). Cannot be used to set a message ID before sending it on the managed node.

setOptionVar

public void setOptionVar(java.lang.String aValue)
				throws JOpcException
Sets A string containing the optional parameters used for resolving the $OPTION variables by the message interceptor. The string should have the format [<var>=<value>]* with <var> and <value> not containing spaces or the '=' character.

getServiceName

public java.lang.String getServiceName()
								throws JOpcException
Will load the service name.

setServiceName

public void setServiceName(java.lang.String aValue)
					throws JOpcException
Sets the service name.